Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add or enhance meta titles and descriptions #4019

Merged
merged 15 commits into from
Dec 19, 2024
Merged

Conversation

veerapaananen
Copy link
Collaborator

Add or enhance meta titles and descriptions for article pages of the docs' for latest Vaadin version. The improved titles and descriptions aim to improve the ranking of the documentation pages in search engines and thus help users find what they are searching for faster.

In a .adoc file the property

  • page-title represents the content for the <title> tag in the page's head, it is also shown as the page's tab title in the browser
  • meta-description represents the content for the description tags in the page's head, such as <meta name="description"> and <meta property="og:description">

Recommendations for titles:

  • Length between 50-60 characters
  • Start with How to whenever it’s fitting, as these are documentation pages which many include tutorials and code examples
  • Add Vaadin somewhere
  • Use | as a separator
  • Possible examples:
    How to choose proper hostnames for Control Center | Vaadin
    How to implement background jobs in your Vaadin applications
    Local development mode for Vaadin apps using control center

Recommendations for descriptions:

  • Max length 150-160 characters
  • Add Vaadin somewhere
  • Example:
    title: Domain Primitives
    meta-title: How to use domain primitives in your Vaadin applications
    description: Learn what domain primitives are and how to use them in your applications.
    meta-description: Domain primitives are Java classes that have specific qualities. See our documentation and code examples to learn how to use them in your Vaadin applications.

Veera Paananen added 10 commits December 17, 2024 13:08
…f the latest docs version: Building Apps -section
…f the latest docs version: Components -section
…f the latest docs version: Contributing -section
…f the latest docs version: Control Center -section
…f the latest docs version: Getting Started -section
…f the latest docs version: Styling -section
…f the latest docs version: compatibility, upgrading and documentation root pages
@CLAassistant
Copy link

CLAassistant commented Dec 17, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ peholmst
❌ Veera Paananen


Veera Paananen seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Veera Paananen seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added the Language unchecked English language and AsciiDoc formatting checks haven't been done label Dec 17, 2024
@peholmst
Copy link
Member

peholmst commented Dec 19, 2024

The Vale errors must be fixed before this PR can be merged. I can get started on this.

@peholmst peholmst marked this pull request as ready for review December 19, 2024 11:55
@peholmst peholmst merged commit 472f9b3 into latest Dec 19, 2024
1 of 4 checks passed
@peholmst peholmst deleted the feature/enhance-meta-tags branch December 19, 2024 11:55
@russelljtdyer russelljtdyer removed the Language unchecked English language and AsciiDoc formatting checks haven't been done label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants